com.highdeal.pnr.hci

Class ChargingResult

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.pnr.hci.ChargingResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

public class ChargingResult
extends HCIModelAdapter

This Java class represents a charging result that contains information about the result of a charging operation.

It can contain the following elements, which can be filtered individually:

• Information about the charging process
• Information about the charging contract (charging view of a provider contract) associated to the charging result
• Information about the chargeable item associated to the result
• The list of account operations generated by the processing of the charging operation.
• The list of external accounts impacted by the operation.
• The list of prepaid accounts impacted by the operation.
• The list of charged items generated by the operation.
• The list of response items generated by the operation.
• The list of notifications generated by the operation.

See Also:

PurchaseOrder

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="chargingResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="chargingProcessInfo" minOccurs="0" maxOccurs="1" />
       <xs:element ref="chargingContractInfo" minOccurs="0" maxOccurs="1" />
       <xs:element ref="chargeableItemInfo" minOccurs="0" maxOccurs="1" />
       <xs:element ref="accountOperation" minOccurs="0" maxOccurs="unbounded" />
       <xs:element ref="externalAccount" minOccurs="0" maxOccurs="unbounded" />
       <xs:element ref="prepaidAccount" minOccurs="0" maxOccurs="unbounded" />
       <xs:element ref="chargedItem" minOccurs="0" maxOccurs="unbounded" />
       <xs:element ref="responseItem" minOccurs="0" maxOccurs="unbounded" />
       <xs:element ref="notification" minOccurs="0" maxOccurs="unbounded" />
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_NAME The XML tag name of this object: "chargingResult"

Constructor Summary

Constructors

Constructor and Description
ChargingResult() Builds an empty charging result object.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
List<AccountOperation>	getAccountOperations() Gets the list of account operations generated by the operation.
ChargeableItemInfo	getChargeableItemInfo() Gets the chargeable item information contained in this charging result.
List<ChargedItem>	getChargedItems() Gets the list of charged items generated by the operation.
ChargingContractInfo	getChargingContractInfo() Gets the charging contract information contained in this charging result.
ChargingProcessInfo	getChargingProcessInfo() Gets the charging process information contained in this charging result.
List<ExternalAccountModel>	getExternalAccounts() Gets the list of external accounts impacted by the operation.
List<Notification>	getNotifications() Gets the list of notifications generated by the operation.
List<PrepaidAccountModel>	getPrepaidAccounts() Gets the list of prepaid accounts impacted by the operation.
List<ResponseItem>	getResponseItems() Gets the list of response items generated by the operation.
String	getTagName() Gets the XML tag name of the HCI model.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setChargeableItemInfo(ChargeableItemInfo chargeableItemInfo) Sets the chargeable item information contained in this charging result.
void	setChargingContractInfo(ChargingContractInfo chargingContractInfo) Sets the charging contract information contained in this charging result.
void	setChargingProcessInfo(ChargingProcessInfo chargingProcessInfo) Sets the charging process information contained in this charging result.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

The XML tag name of this object: "chargingResult"

See Also:

Constant Field Values

Constructor Detail

ChargingResult

public ChargingResult()

Builds an empty charging result object.

Method Detail

getChargingProcessInfo

public ChargingProcessInfo getChargingProcessInfo()

Gets the charging process information contained in this charging result.

Returns:

The charging process information contained in this charging result

setChargingProcessInfo

public void setChargingProcessInfo(ChargingProcessInfo chargingProcessInfo)

Sets the charging process information contained in this charging result.

Parameters:

chargingProcessInfo - The charging process information contained in this charging result

getChargingContractInfo

public ChargingContractInfo getChargingContractInfo()

Gets the charging contract information contained in this charging result.

Returns:

The charging contract information contained in this charging result

setChargingContractInfo

public void setChargingContractInfo(ChargingContractInfo chargingContractInfo)

Sets the charging contract information contained in this charging result.

Parameters:

chargingContractInfo - The charging contract information contained in this charging result

getChargeableItemInfo

public ChargeableItemInfo getChargeableItemInfo()

Gets the chargeable item information contained in this charging result.

Returns:

The chargeable item information contained in this charging result

setChargeableItemInfo

public void setChargeableItemInfo(ChargeableItemInfo chargeableItemInfo)

Sets the chargeable item information contained in this charging result.

Parameters:

chargeableItemInfo - The chargeable item information contained in this charging result

getAccountOperations

public List<AccountOperation> getAccountOperations()

Gets the list of account operations generated by the operation.

Returns:

The list of account operations generated by the operation

getExternalAccounts

public List<ExternalAccountModel> getExternalAccounts()

Gets the list of external accounts impacted by the operation.

Returns:

The list of external accounts impacted by the operation

getPrepaidAccounts

public List<PrepaidAccountModel> getPrepaidAccounts()

Gets the list of prepaid accounts impacted by the operation.

Returns:

The list of prepaid accounts impacted by the operation

getChargedItems

public List<ChargedItem> getChargedItems()

Gets the list of charged items generated by the operation.

Returns:

The list of charged items generated by the operation

getResponseItems

public List<ResponseItem> getResponseItems()

Gets the list of response items generated by the operation.

Returns:

The list of response items generated by the operation

getNotifications

public List<Notification> getNotifications()

Gets the list of notifications generated by the operation.

Returns:

The list of notifications generated by the operation

getTagName

public String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name

addCharacterData

public void addCharacterData(String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into